Skip to main content

Query Lifetime Deposit and Withdrawal Summary

Type: GET

Description: /v4/user/account/broker-sub/fund-summary

Queries the lifetime cumulative deposits and withdrawals, converted to USDT, of the broker's own master account or one of its sub-accounts. Sign the request with the broker master account's API Key.

Parameters​

NameTypeMandatoryDefaultDescriptionRanges
uidlongtrue-Query target: the broker's own master account uid or a sub-account id belonging to the broker-
detailbooleanfalsefalseIf true, the response also includes the per-currency byCurrency breakdowntrue / false
Calculation rules
  • Only records with status SUCCESS are counted.
  • Amounts are converted to USDT at the price at the time of each record.
  • For a sub-account, "withdrawal" means cumulative transfers out from the sub-account to the master account (fund collection).

Request Example​

curl -X GET '{baseUrl}/v4/user/account/broker-sub/fund-summary?uid=10645823292041&detail=true' \
-H 'validate-algorithms: HmacSHA256' \
-H 'validate-appkey: {accessKey}' \
-H 'validate-recvwindow: 5000' \
-H 'validate-timestamp: {timestamp}' \
-H 'validate-signature: {signature}'

Response Example​

Response
{
"rc": 0,
"mc": "SUCCESS",
"result": {
"userId": 10645823292041,
"totalDepositU": "0",
"totalWithdrawU": "100",
"netInflowU": "-100",
"depositCount": 0,
"withdrawCount": 1,
"firstDepositTime": null,
"lastDepositTime": null,
"firstWithdrawTime": 1792144413000,
"lastWithdrawTime": 1792144413000,
"updatedTime": 1792149635806,
"byCurrency": [
{ "currency": "usdt", "depositAmount": "0", "withdrawAmount": "100" }
]
}
}

Response Parameters​

NameTypeDescription
userIdlongQueried account id
totalDepositUstringCumulative deposits converted to USDT
totalWithdrawUstringCumulative withdrawals / transfers out converted to USDT
netInflowUstringNet inflow in USDT (deposits - withdrawals)
depositCountlongNumber of deposits
withdrawCountlongNumber of withdrawals / transfers out
firstDepositTime / lastDepositTimelongFirst / last deposit time (milliseconds); null if none
firstWithdrawTime / lastWithdrawTimelongFirst / last withdrawal time (milliseconds); null if none
updatedTimelongStatistics update time (milliseconds)
byCurrency[].currencystringCurrency; returned only when detail=true
byCurrency[].depositAmountstringDeposit amount in the original currency
byCurrency[].withdrawAmountstringWithdrawal / transfer-out amount in the original currency